HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 -
HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dispense | Version: 0.1.0 | |||
| Active as of 2026-08-12 | Computable Name: ZMCoreMedicationDispense | |||
Zambia medication dispensing profile linking dispensed medicine to the prescription, patient, encounter, and dispensing facility.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and their representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 1..* | Identifier | External identifier |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. |
![]() ![]() |
SΣ | 1..1 | CodeableReference(ZM-Core Medication Profile) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
![]() ![]() |
SΣ | 1..1 | Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) | Who the dispense is for |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Encounter Profile) | Encounter associated with event |
![]() ![]() |
S | 1..* | BackboneElement | Who performed event |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |
![]() ![]() |
S | 1..* | Reference(ZM-Core MedicationRequest Profile) | Medication order that authorizes the dispense |
![]() ![]() |
S | 1..1 | SimpleQuantity(5.0.0) | Amount dispensed |
![]() ![]() |
S | 0..1 | SimpleQuantity(5.0.0) | Amount of medication expressed as a timing amount |
![]() ![]() |
S | 1..1 | dateTime | When the recording of the dispense started |
![]() ![]() |
SΣC | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() |
SC | 0..1 | dateTime | When product was given out |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Location Profile) | Where the medication was/will be sent |
![]() ![]() |
S | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered |
![]() ![]() |
S | 0..* | Annotation | Information about the dispense |
![]() ![]() |
S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| MedicationDispense.status | Base | required | MedicationDispense Status Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.medication | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
![]() ![]() |
S | 1..* | Identifier | External identifier |
![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown |
![]() ![]() |
S | 1..1 | CodeableReference(ZM-Core Medication Profile) | What medication was supplied |
![]() ![]() |
S | 1..1 | Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) | Who the dispense is for |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Encounter Profile) | Encounter associated with event |
![]() ![]() |
S | 1..* | BackboneElement | Who performed event |
![]() ![]() |
S | 1..* | Reference(ZM-Core MedicationRequest Profile) | Medication order that authorizes the dispense |
![]() ![]() |
S | 1..1 | SimpleQuantity(5.0.0) | Amount dispensed |
![]() ![]() |
S | 0..1 | SimpleQuantity(5.0.0) | Amount of medication expressed as a timing amount |
![]() ![]() |
S | 1..1 | dateTime | When the recording of the dispense started |
![]() ![]() |
S | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() |
S | 0..1 | dateTime | When product was given out |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Location Profile) | Where the medication was/will be sent |
![]() ![]() |
S | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered |
![]() ![]() |
S | 0..* | Annotation | Information about the dispense |
![]() ![]() |
S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
S | 1..* | Identifier | External identifier | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
0..* | Reference(CarePlan) | Plan that is fulfilled by this dispense | |||||
![]() ![]() |
0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | |||||
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. | ||||
![]() ![]() |
0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispenseStatusReasonCodes (example) | |||||
![]() ![]() |
0..1 | dateTime | When the status changed | |||||
![]() ![]() |
0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispenseAdministrationLocationCodes (example): A code describing where the dispensed medication is expected to be consumed or administered. | |||||
![]() ![]() |
SΣ | 1..1 | CodeableReference(ZM-Core Medication Profile) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) | Who the dispense is for | ||||
![]() ![]() |
S | 0..1 | Reference(ZM-Core Encounter Profile) | Encounter associated with event | ||||
![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||
![]() ![]() |
S | 1..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispensePerformerFunctionCodes (example): A code describing the role an individual played in dispensing a medication. | |||||
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the dispense occurred | |||||
![]() ![]() |
S | 1..* | Reference(ZM-Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
![]() ![]() |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |||||
![]() ![]() |
S | 1..1 | SimpleQuantity(5.0.0) | Amount dispensed | ||||
![]() ![]() |
S | 0..1 | SimpleQuantity(5.0.0) | Amount of medication expressed as a timing amount | ||||
![]() ![]() |
S | 1..1 | dateTime | When the recording of the dispense started | ||||
![]() ![]() |
SΣC | 0..1 | dateTime | When product was packaged and reviewed | ||||
![]() ![]() |
SC | 0..1 | dateTime | When product was given out | ||||
![]() ![]() |
S | 0..1 | Reference(ZM-Core Location Profile) | Where the medication was/will be sent | ||||
![]() ![]() |
S | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | ||||
![]() ![]() |
S | 0..* | Annotation | Information about the dispense | ||||
![]() ![]() |
0..1 | markdown | Full representation of the dosage instructions | |||||
![]() ![]() |
S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
![]() ![]() |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): ActSubstanceAdminSubstitutionCode | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | |||||
![]() ![]() |
0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| MedicationDispense.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.status | Base | required | MedicationDispense Status Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.notPerformedReason | Base | example | MedicationDispense Status Reason Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.category | Base | example | MedicationDispense Administration Location Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.medication | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.performer.function | Base | example | MedicationDispense Performer Function Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.type | Base | example | ActPharmacySupplyType | 📦3.0.0 | THO v7.1 |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.1 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
Summary
Mandatory: 7 elements
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 1..* | Identifier | External identifier |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. |
![]() ![]() |
SΣ | 1..1 | CodeableReference(ZM-Core Medication Profile) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
![]() ![]() |
SΣ | 1..1 | Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) | Who the dispense is for |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Encounter Profile) | Encounter associated with event |
![]() ![]() |
S | 1..* | BackboneElement | Who performed event |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |
![]() ![]() |
S | 1..* | Reference(ZM-Core MedicationRequest Profile) | Medication order that authorizes the dispense |
![]() ![]() |
S | 1..1 | SimpleQuantity(5.0.0) | Amount dispensed |
![]() ![]() |
S | 0..1 | SimpleQuantity(5.0.0) | Amount of medication expressed as a timing amount |
![]() ![]() |
S | 1..1 | dateTime | When the recording of the dispense started |
![]() ![]() |
SΣC | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() |
SC | 0..1 | dateTime | When product was given out |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Location Profile) | Where the medication was/will be sent |
![]() ![]() |
S | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered |
![]() ![]() |
S | 0..* | Annotation | Information about the dispense |
![]() ![]() |
S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| MedicationDispense.status | Base | required | MedicationDispense Status Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.medication | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
![]() ![]() |
S | 1..* | Identifier | External identifier |
![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown |
![]() ![]() |
S | 1..1 | CodeableReference(ZM-Core Medication Profile) | What medication was supplied |
![]() ![]() |
S | 1..1 | Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) | Who the dispense is for |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Encounter Profile) | Encounter associated with event |
![]() ![]() |
S | 1..* | BackboneElement | Who performed event |
![]() ![]() |
S | 1..* | Reference(ZM-Core MedicationRequest Profile) | Medication order that authorizes the dispense |
![]() ![]() |
S | 1..1 | SimpleQuantity(5.0.0) | Amount dispensed |
![]() ![]() |
S | 0..1 | SimpleQuantity(5.0.0) | Amount of medication expressed as a timing amount |
![]() ![]() |
S | 1..1 | dateTime | When the recording of the dispense started |
![]() ![]() |
S | 0..1 | dateTime | When product was packaged and reviewed |
![]() ![]() |
S | 0..1 | dateTime | When product was given out |
![]() ![]() |
S | 0..1 | Reference(ZM-Core Location Profile) | Where the medication was/will be sent |
![]() ![]() |
S | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered |
![]() ![]() |
S | 0..* | Annotation | Information about the dispense |
![]() ![]() |
S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
S | 1..* | Identifier | External identifier | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
0..* | Reference(CarePlan) | Plan that is fulfilled by this dispense | |||||
![]() ![]() |
0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | |||||
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. | ||||
![]() ![]() |
0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispenseStatusReasonCodes (example) | |||||
![]() ![]() |
0..1 | dateTime | When the status changed | |||||
![]() ![]() |
0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispenseAdministrationLocationCodes (example): A code describing where the dispensed medication is expected to be consumed or administered. | |||||
![]() ![]() |
SΣ | 1..1 | CodeableReference(ZM-Core Medication Profile) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) | Who the dispense is for | ||||
![]() ![]() |
S | 0..1 | Reference(ZM-Core Encounter Profile) | Encounter associated with event | ||||
![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||
![]() ![]() |
S | 1..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispensePerformerFunctionCodes (example): A code describing the role an individual played in dispensing a medication. | |||||
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the dispense occurred | |||||
![]() ![]() |
S | 1..* | Reference(ZM-Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
![]() ![]() |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |||||
![]() ![]() |
S | 1..1 | SimpleQuantity(5.0.0) | Amount dispensed | ||||
![]() ![]() |
S | 0..1 | SimpleQuantity(5.0.0) | Amount of medication expressed as a timing amount | ||||
![]() ![]() |
S | 1..1 | dateTime | When the recording of the dispense started | ||||
![]() ![]() |
SΣC | 0..1 | dateTime | When product was packaged and reviewed | ||||
![]() ![]() |
SC | 0..1 | dateTime | When product was given out | ||||
![]() ![]() |
S | 0..1 | Reference(ZM-Core Location Profile) | Where the medication was/will be sent | ||||
![]() ![]() |
S | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | ||||
![]() ![]() |
S | 0..* | Annotation | Information about the dispense | ||||
![]() ![]() |
0..1 | markdown | Full representation of the dosage instructions | |||||
![]() ![]() |
S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
![]() ![]() |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): ActSubstanceAdminSubstitutionCode | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | |||||
![]() ![]() |
0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| MedicationDispense.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.status | Base | required | MedicationDispense Status Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.notPerformedReason | Base | example | MedicationDispense Status Reason Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.category | Base | example | MedicationDispense Administration Location Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.medication | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.performer.function | Base | example | MedicationDispense Performer Function Codes | 📍5.0.0 | FHIR Std. |
| MedicationDispense.type | Base | example | ActPharmacySupplyType | 📦3.0.0 | THO v7.1 |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.1 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared |
whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
|
Summary
Mandatory: 7 elements
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron